v15.0.1

Compare Source

• 54ee687 Fix typo

Full Changelog: remarkjs/remark@15.0.0...15.0.1

v15.0.0

Compare Source

Change

• 98a2560 Change to require Node.js 16
  migrate: update too
• a3e6d54 Change to use exports
  migrate: don’t use private APIs
• 943f6ac Update @types/mdast, mdast-util-{from,to}-markdown, unified, etc
  migrate: update too
  remark-parse: only really changes Buffer -> Uint8Array, so use encodings supported by TextDecoder if you are passing binary data
  remark-stringify: bulletOrderedOther is removed, you can remove bulletOrderedOther if you passed it, it’s now the default;
  fences is now true by default, if you don’t want indented code, pass fences: false;
  listItemIndent is now 'one' by default, you can remove listItemIndent: 'one' if you passed it, or explicitly set it to 'tab' if you want it

Types

• bd8c922 Add typed settings

Docs

• 7cc0432 Add remark-link-rewrite to list of plugins
  by @​rjanjic in https://github.com/remarkjs/remark/pull/1212
• e72d91a Add remark-mentions to list of plugins
  by @​FinnRG in https://github.com/remarkjs/remark/pull/1193

Full Changelog: remarkjs/remark@14.0.3...15.0.0

v14.0.3

Compare Source

Misc

• Rerelease types for changes in TypeScript
  https://github.com/remarkjs/remark/issues/11621162
• f6bd64e Refactor tsconfigs for perf and strictness
• bb4c814 Add improved docs on what this project is
  by @​BeLi4L in https://github.com/remarkjs/remark/pull/1147
• bec44aa Update tsconfig.json to use node16 module resolution
  by @​ChristianMurphy in https://github.com/remarkjs/remark/pull/1106
• f07f413 Add ignore-scripts to .npmrc
  by @​ChristianMurphy in https://github.com/remarkjs/remark/pull/1103
• 134ece2 Update Actions
  by @​ChristianMurphy in https://github.com/remarkjs/remark/pull/1070
• 974f893 Fix internal types for TS 4.9

Plugins

• 1e488d0 Add remark-ins to list of plugins
  by @​talatkuyuk in https://github.com/remarkjs/remark/pull/1129
• e456dc5 Add remark-flexible-markers to list of plugins
  by @​talatkuyuk in https://github.com/remarkjs/remark/pull/1126
• 42114fc Add remark-flexible-paragraphs to list of plugins
  by @​talatkuyuk in https://github.com/remarkjs/remark/pull/1120
• 6aa638a Add remark-flexible-containers to list of plugins
  by @​talatkuyuk in https://github.com/remarkjs/remark/pull/1112
• 20e7543 Add remark-flexible-code-titles to list of plugins
  by @​talatkuyuk in https://github.com/remarkjs/remark/pull/1108
• 32d6948 Add remark-cloudinary-docusaurus to list of plugins
  by @​johnnyreilly in https://github.com/remarkjs/remark/pull/1090
• 28aa8b9 update tests for changes in mdast-util-to-markdown
• 9af1a87 Add remark-code-title to list of plugins
  by @​kevinzunigacuellar in https://github.com/remarkjs/remark/pull/1076
• 0d1eb09 Add 7 plugins to list of plugins
  by @​Xunnamius in https://github.com/remarkjs/remark/pull/1064
• c7e8171 Remove deprecated remark-jargon
  by @​LunaticMuch in https://github.com/remarkjs/remark/pull/1059

Full Changelog: remarkjs/remark@14.0.2...14.0.3

v14.0.2

Compare Source

• 87c50a5 Add improved docs
  by @​wooorm in https://github.com/remarkjs/remark/pull/900

Full Changelog: remarkjs/remark@14.0.1...14.0.2

v14.0.1

Compare Source

• 9026568 Add missing types dependency

v14.0.0

Compare Source

• b7afd25 Use ESM

  • Change:

    // From CommonJS
    var remark = require('remark')
    
    // To ESM
    import {remark} from 'remark'
    
    // Plugins use default exports:
    var remarkParse = require('remark-parse') // => import remarkParse from 'remark-parse'
    var remarkStringify = require('remark-stringify') // => import remarkStringify from 'remark-stringify'

    Learn more about ESM in this guide

• 42d1b21 Update dependencies
  • Update unified (10.0.0) (see: https://github.com/unifiedjs/unified/releases/tag/10.0.0)
  • Update vfile (5.0.0) (see: https://github.com/vfile/vfile/releases/tag/5.0.0)
    Importantly this renames vfile.contents to vfile.value
  • Update mdast-util-from-markdown (1.0.0) (see: https://github.com/syntax-tree/mdast-util-from-markdown/releases/tag/1.0.0)
  • Update mdast-util-to-markdown (1.0.0) (see: https://github.com/syntax-tree/mdast-util-to-markdown/releases/tag/1.0.0)
• bc55caa Add JSDoc based types

v13.0.0: (micromark)

Compare Source

This is a giant change for remark. It replaces the 5+ year old internals with a new low-level parser: micromark. The old internals have served billions of users well over the years, but markdown has changed over that time. micromark comes with 100% CommonMark (and GFM as an extension) compliance, and (WIP) docs on parsing rules for how to tokenize markdown with a state machine. micromark, and micromark in remark, is a good base for the future.

Migration

• Update all the remark* packages you are using in package.json
• Did you use GFM (tables and so, used to be the default)? Now add remark-gfm
• Try running it all. If it fails, you are probably using a syntax extension which hasn’t been updated yet, there are issues open on the issue trackers of those plugins already
• Compare the previous output to the new output: anything wrong? See below for the changelog which might cover it. Otherwise, It’s probably because remark is now CommonMark (or GFM) compliant.
  Please compare with those projects if the new behavior is correct or not (CommonMark Dingus, or create a gist for GFM).
  Does remark not match those reference parsers? Please open an issue here!

Changes

remark-parse

remark-parse now defers its work to micromark and mdast-util-from-markdown. micromark is a new, small, complete, and CommonMark compliant low-level markdown parser. from-markdown turns its tokens into the previously (and still) used syntax tree: mdast. Extensions to remark-parse work differently: they’re a two-part act. See for example micromark-extension-footnote and mdast-util-footnote.

• change: commonmark is no longer an option — it’s the default
• move: gfm is no longer an option — moved to remark-gfm
• remove: pedantic is no longer an option — this legacy and buggy flavor of markdown is no longer widely used
• remove: blocks is no longer an options — it’s no longer suggested to change the internal list of HTML “block” tag names

remark-stringify

remark-stringify now defers its work to mdast-util-to-markdown. It’s a new and better serializer with powerful features to ensure serialized markdown represents the syntax tree (mdast), no matter what plugins do. Extensions to it work differently: see for example mdast-util-footnote.

options

• change: commonmark is no longer an option, it’s the default
• change: emphasis now defaults to *
• change: bullet now defaults to *
• move: gfm is no longer an option — moved to remark-gfm
• move: tableCellPadding — moved to remark-gfm
• move: tablePipeAlign — moved to remark-gfm
• move: stringLength — moved to remark-gfm
• remove: pedantic is no longer an option — this legacy and buggy flavor of markdown is no longer widely used
• remove: entities is no longer an option — with CommonMark there is almost never a need to use character references, as character escapes are preferred
• new: quote — you can now prefer single quotes (') over double quotes (") in titles

Changes to output / the tree

All of these are for CommonMark compatibility. They’re all fixes. Most of them are inconsequential to most folks.

• notable: references (as in, links [text][id] and images ![alt][id]) are no longer present as such in the syntax tree if they don’t have a corresponding definition ([id]: example.com). The reason for this is that CommonMark requires [text *emphasis start][undefined] emphasis end* to be emphasis.
• notable: it is no longer possible to use two blank lines between two lists or a list and indented code. CommonMark prohibits it. For a solution, use an empty comment to end lists (<!---->)
• inconsequential: whitespace at the start and end of lines in paragraphs is now ignored
• inconsequential: <mailto:foobarbaz> are now correctly parsed, and the scheme is part of the tree
• inconsequential: indented code can now follow a block quote w/o blank line
• inconsequential: trailing indented blank lines after indented code are no longer part of that code
• inconsequential: character references and escapes are no longer present as separate text nodes
• inconsequential: character references which HTML allows but CommonMark doesn’t, such as &copy w/o the semicolon, are no longer recognized
• inconsequential: the indent field is no longer available on position
• fix: multiline setext headings
• fix: lazy lists
• fix: attention (emphasis, strong)
• fix: tabs
• fix: empty alt on images is now present as an empty string
• …plus a ton of other minor previous differences from CommonMark

Thanks

Thanks to Salesforce, Gatsby, Vercel, and Netlify, and our other backers for sponsoring the work on micromark!
To support our continued work, back us on OpenCollective!

v12.0.1

Compare Source

• a185821 Update internal import-meta-resolve

Full Changelog: https://github.com/remarkjs/remark/compare/[email protected]@12.0.1

v12.0.0

Compare Source

(see 15.0.0)

v5.0.0

Compare Source

v4.0.1

Compare Source

• cf5b45e Update docs, tests for changes in remark-rehype

v4.0.0

Compare Source

• 6ec8372 Use ESM

  // From CommonJS
  var remarkFootnotes = require('remark-footnotes')
  
  // To ESM
  import remarkFootnotes from 'remark-footnotes'

  Learn more about ESM in this guide
• 6249e02 Add JSDoc based types
• 4c4f827 Remove warning for remark 12

v3.0.0

Compare Source

• 0cfeae1 Update for micromark in remark@13
  (breaking, this update will not work with remark lower than v13, and see commit for other changes)

v2.0.0

Compare Source

• 020aa32 Add types
  (breaking, potentially, if you or your dependents use typescript)